3 * @defgroup FileRepo File Repository
5 * @brief This module handles how MediaWiki interacts with filesystems.
11 * Base code for file repositories.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 * http://www.gnu.org/copyleft/gpl.html
33 * Base class for file repositories
38 const DELETE_SOURCE
= 1;
40 const OVERWRITE_SAME
= 4;
41 const SKIP_LOCKING
= 8;
43 const NAME_AND_TIME_ONLY
= 1;
45 /** @var bool Whether to fetch commons image description pages and display
46 * them on the local wiki */
47 public $fetchDescription;
50 public $descriptionCacheExpiry;
53 protected $hasSha1Storage = false;
56 protected $supportsSha1URLs = false;
58 /** @var FileBackend */
61 /** @var array Map of zones to config */
62 protected $zones = [];
64 /** @var string URL of thumb.php */
65 protected $thumbScriptUrl;
67 /** @var bool Whether to skip media file transformation on parse and rely
68 * on a 404 handler instead. */
69 protected $transformVia404;
71 /** @var string URL of image description pages, e.g.
72 * https://en.wikipedia.org/wiki/File:
74 protected $descBaseUrl;
76 /** @var string URL of the MediaWiki installation, equivalent to
77 * $wgScriptPath, e.g. https://en.wikipedia.org/w
79 protected $scriptDirUrl;
81 /** @var string Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1 */
82 protected $articleUrl;
84 /** @var bool Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE],
85 * determines whether filenames implicitly start with a capital letter.
86 * The current implementation may give incorrect description page links
87 * when the local $wgCapitalLinks and initialCapital are mismatched.
89 protected $initialCapital;
91 /** @var string May be 'paranoid' to remove all parameters from error
92 * messages, 'none' to leave the paths in unchanged, or 'simple' to
93 * replace paths with placeholders. Default for LocalRepo is
96 protected $pathDisclosureProtection = 'simple';
98 /** @var string|false Public zone URL. */
101 /** @var string The base thumbnail URL. Defaults to "<url>/thumb". */
104 /** @var int The number of directory levels for hash-based division of files */
105 protected $hashLevels;
107 /** @var int The number of directory levels for hash-based division of deleted files */
108 protected $deletedHashLevels;
110 /** @var int File names over this size will use the short form of thumbnail
111 * names. Short thumbnail names only have the width, parameters, and the
114 protected $abbrvThreshold;
116 /** @var string The URL of the repo's favicon, if any */
119 /** @var bool Whether all zones should be private (e.g. private wiki repo) */
120 protected $isPrivate;
122 /** @var array callable Override these in the base class */
123 protected $fileFactory = [ UnregisteredLocalFile
::class, 'newFromTitle' ];
124 /** @var array callable|bool Override these in the base class */
125 protected $oldFileFactory = false;
126 /** @var array callable|bool Override these in the base class */
127 protected $fileFactoryKey = false;
128 /** @var array callable|bool Override these in the base class */
129 protected $oldFileFactoryKey = false;
131 /** @var string URL of where to proxy thumb.php requests to.
132 * Example: http://127.0.0.1:8888/wiki/dev/thumb/
134 protected $thumbProxyUrl;
135 /** @var string Secret key to pass as an X-Swift-Secret header to the proxied thumb service */
136 protected $thumbProxySecret;
139 * @param array|null $info
140 * @throws MWException
142 public function __construct( array $info = null ) {
143 // Verify required settings presence
146 ||
!array_key_exists( 'name', $info )
147 ||
!array_key_exists( 'backend', $info )
149 throw new MWException( __CLASS__
.
150 " requires an array of options having both 'name' and 'backend' keys.\n" );
154 $this->name
= $info['name'];
155 if ( $info['backend'] instanceof FileBackend
) {
156 $this->backend
= $info['backend']; // useful for testing
158 $this->backend
= FileBackendGroup
::singleton()->get( $info['backend'] );
161 // Optional settings that can have no value
162 $optionalSettings = [
163 'descBaseUrl', 'scriptDirUrl', 'articleUrl', 'fetchDescription',
164 'thumbScriptUrl', 'pathDisclosureProtection', 'descriptionCacheExpiry',
165 'favicon', 'thumbProxyUrl', 'thumbProxySecret',
167 foreach ( $optionalSettings as $var ) {
168 if ( isset( $info[$var] ) ) {
169 $this->$var = $info[$var];
173 // Optional settings that have a default
174 $this->initialCapital
= isset( $info['initialCapital'] )
175 ?
$info['initialCapital']
176 : MWNamespace
::isCapitalized( NS_FILE
);
177 $this->url
= isset( $info['url'] )
179 : false; // a subclass may set the URL (e.g. ForeignAPIRepo)
180 if ( isset( $info['thumbUrl'] ) ) {
181 $this->thumbUrl
= $info['thumbUrl'];
183 $this->thumbUrl
= $this->url ?
"{$this->url}/thumb" : false;
185 $this->hashLevels
= isset( $info['hashLevels'] )
186 ?
$info['hashLevels']
188 $this->deletedHashLevels
= isset( $info['deletedHashLevels'] )
189 ?
$info['deletedHashLevels']
191 $this->transformVia404
= !empty( $info['transformVia404'] );
192 $this->abbrvThreshold
= isset( $info['abbrvThreshold'] )
193 ?
$info['abbrvThreshold']
195 $this->isPrivate
= !empty( $info['isPrivate'] );
196 // Give defaults for the basic zones...
197 $this->zones
= isset( $info['zones'] ) ?
$info['zones'] : [];
198 foreach ( [ 'public', 'thumb', 'transcoded', 'temp', 'deleted' ] as $zone ) {
199 if ( !isset( $this->zones
[$zone]['container'] ) ) {
200 $this->zones
[$zone]['container'] = "{$this->name}-{$zone}";
202 if ( !isset( $this->zones
[$zone]['directory'] ) ) {
203 $this->zones
[$zone]['directory'] = '';
205 if ( !isset( $this->zones
[$zone]['urlsByExt'] ) ) {
206 $this->zones
[$zone]['urlsByExt'] = [];
210 $this->supportsSha1URLs
= !empty( $info['supportsSha1URLs'] );
214 * Get the file backend instance. Use this function wisely.
216 * @return FileBackend
218 public function getBackend() {
219 return $this->backend
;
223 * Get an explanatory message if this repo is read-only.
224 * This checks if an administrator disabled writes to the backend.
226 * @return string|bool Returns false if the repo is not read-only
228 public function getReadOnlyReason() {
229 return $this->backend
->getReadOnlyReason();
233 * Check if a single zone or list of zones is defined for usage
235 * @param array $doZones Only do a particular zones
236 * @throws MWException
239 protected function initZones( $doZones = [] ) {
240 $status = $this->newGood();
241 foreach ( (array)$doZones as $zone ) {
242 $root = $this->getZonePath( $zone );
243 if ( $root === null ) {
244 throw new MWException( "No '$zone' zone defined in the {$this->name} repo." );
252 * Determine if a string is an mwrepo:// URL
257 public static function isVirtualUrl( $url ) {
258 return substr( $url, 0, 9 ) == 'mwrepo://';
262 * Get a URL referring to this repository, with the private mwrepo protocol.
263 * The suffix, if supplied, is considered to be unencoded, and will be
264 * URL-encoded before being returned.
266 * @param string|bool $suffix
269 public function getVirtualUrl( $suffix = false ) {
270 $path = 'mwrepo://' . $this->name
;
271 if ( $suffix !== false ) {
272 $path .= '/' . rawurlencode( $suffix );
279 * Get the URL corresponding to one of the four basic zones
281 * @param string $zone One of: public, deleted, temp, thumb
282 * @param string|null $ext Optional file extension
283 * @return string|bool
285 public function getZoneUrl( $zone, $ext = null ) {
286 if ( in_array( $zone, [ 'public', 'thumb', 'transcoded' ] ) ) {
287 // standard public zones
288 if ( $ext !== null && isset( $this->zones
[$zone]['urlsByExt'][$ext] ) ) {
289 // custom URL for extension/zone
290 return $this->zones
[$zone]['urlsByExt'][$ext];
291 } elseif ( isset( $this->zones
[$zone]['url'] ) ) {
292 // custom URL for zone
293 return $this->zones
[$zone]['url'];
301 return false; // no public URL
303 return $this->thumbUrl
;
305 return "{$this->url}/transcoded";
312 * @return bool Whether non-ASCII path characters are allowed
314 public function backendSupportsUnicodePaths() {
315 return (bool)( $this->getBackend()->getFeatures() & FileBackend
::ATTR_UNICODE_PATHS
);
319 * Get the backend storage path corresponding to a virtual URL.
320 * Use this function wisely.
323 * @throws MWException
326 public function resolveVirtualUrl( $url ) {
327 if ( substr( $url, 0, 9 ) != 'mwrepo://' ) {
328 throw new MWException( __METHOD__
. ': unknown protocol' );
330 $bits = explode( '/', substr( $url, 9 ), 3 );
331 if ( count( $bits ) != 3 ) {
332 throw new MWException( __METHOD__
. ": invalid mwrepo URL: $url" );
334 list( $repo, $zone, $rel ) = $bits;
335 if ( $repo !== $this->name
) {
336 throw new MWException( __METHOD__
. ": fetching from a foreign repo is not supported" );
338 $base = $this->getZonePath( $zone );
340 throw new MWException( __METHOD__
. ": invalid zone: $zone" );
343 return $base . '/' . rawurldecode( $rel );
347 * The the storage container and base path of a zone
349 * @param string $zone
350 * @return array (container, base path) or (null, null)
352 protected function getZoneLocation( $zone ) {
353 if ( !isset( $this->zones
[$zone] ) ) {
354 return [ null, null ]; // bogus
357 return [ $this->zones
[$zone]['container'], $this->zones
[$zone]['directory'] ];
361 * Get the storage path corresponding to one of the zones
363 * @param string $zone
364 * @return string|null Returns null if the zone is not defined
366 public function getZonePath( $zone ) {
367 list( $container, $base ) = $this->getZoneLocation( $zone );
368 if ( $container === null ||
$base === null ) {
371 $backendName = $this->backend
->getName();
372 if ( $base != '' ) { // may not be set
376 return "mwstore://$backendName/{$container}{$base}";
380 * Create a new File object from the local repository
382 * @param Title|string $title Title object or string
383 * @param bool|string $time Time at which the image was uploaded. If this
384 * is specified, the returned object will be an instance of the
385 * repository's old file class instead of a current file. Repositories
386 * not supporting version control should return false if this parameter
388 * @return File|null A File, or null if passed an invalid Title
390 public function newFile( $title, $time = false ) {
391 $title = File
::normalizeTitle( $title );
396 if ( $this->oldFileFactory
) {
397 return call_user_func( $this->oldFileFactory
, $title, $this, $time );
402 return call_user_func( $this->fileFactory
, $title, $this );
407 * Find an instance of the named file created at the specified time
408 * Returns false if the file does not exist. Repositories not supporting
409 * version control should return false if the time is specified.
411 * @param Title|string $title Title object or string
412 * @param array $options Associative array of options:
413 * time: requested time for a specific file version, or false for the
414 * current version. An image object will be returned which was
415 * created at the specified time (which may be archived or current).
416 * ignoreRedirect: If true, do not follow file redirects
417 * private: If true, return restricted (deleted) files if the current
418 * user is allowed to view them. Otherwise, such files will not
419 * be found. If a User object, use that user instead of the current.
420 * latest: If true, load from the latest available data into File objects
421 * @return File|bool False on failure
423 public function findFile( $title, $options = [] ) {
424 $title = File
::normalizeTitle( $title );
428 if ( isset( $options['bypassCache'] ) ) {
429 $options['latest'] = $options['bypassCache']; // b/c
431 $time = isset( $options['time'] ) ?
$options['time'] : false;
432 $flags = !empty( $options['latest'] ) ? File
::READ_LATEST
: 0;
433 # First try the current version of the file to see if it precedes the timestamp
434 $img = $this->newFile( $title );
438 $img->load( $flags );
439 if ( $img->exists() && ( !$time ||
$img->getTimestamp() == $time ) ) {
442 # Now try an old version of the file
443 if ( $time !== false ) {
444 $img = $this->newFile( $title, $time );
446 $img->load( $flags );
447 if ( $img->exists() ) {
448 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
449 return $img; // always OK
450 } elseif ( !empty( $options['private'] ) &&
451 $img->userCan( File
::DELETED_FILE
,
452 $options['private'] instanceof User ?
$options['private'] : null
462 if ( !empty( $options['ignoreRedirect'] ) ) {
465 $redir = $this->checkRedirect( $title );
466 if ( $redir && $title->getNamespace() == NS_FILE
) {
467 $img = $this->newFile( $redir );
471 $img->load( $flags );
472 if ( $img->exists() ) {
473 $img->redirectedFrom( $title->getDBkey() );
483 * Find many files at once.
485 * @param array $items An array of titles, or an array of findFile() options with
486 * the "title" option giving the title. Example:
488 * $findItem = [ 'title' => $title, 'private' => true ];
489 * $findBatch = [ $findItem ];
490 * $repo->findFiles( $findBatch );
492 * No title should appear in $items twice, as the result use titles as keys
493 * @param int $flags Supports:
494 * - FileRepo::NAME_AND_TIME_ONLY : return a (search title => (title,timestamp)) map.
495 * The search title uses the input titles; the other is the final post-redirect title.
496 * All titles are returned as string DB keys and the inner array is associative.
497 * @return array Map of (file name => File objects) for matches
499 public function findFiles( array $items, $flags = 0 ) {
501 foreach ( $items as $item ) {
502 if ( is_array( $item ) ) {
503 $title = $item['title'];
505 unset( $options['title'] );
510 $file = $this->findFile( $title, $options );
512 $searchName = File
::normalizeTitle( $title )->getDBkey(); // must be valid
513 if ( $flags & self
::NAME_AND_TIME_ONLY
) {
514 $result[$searchName] = [
515 'title' => $file->getTitle()->getDBkey(),
516 'timestamp' => $file->getTimestamp()
519 $result[$searchName] = $file;
528 * Find an instance of the file with this key, created at the specified time
529 * Returns false if the file does not exist. Repositories not supporting
530 * version control should return false if the time is specified.
532 * @param string $sha1 Base 36 SHA-1 hash
533 * @param array $options Option array, same as findFile().
534 * @return File|bool False on failure
536 public function findFileFromKey( $sha1, $options = [] ) {
537 $time = isset( $options['time'] ) ?
$options['time'] : false;
538 # First try to find a matching current version of a file...
539 if ( !$this->fileFactoryKey
) {
540 return false; // find-by-sha1 not supported
542 $img = call_user_func( $this->fileFactoryKey
, $sha1, $this, $time );
543 if ( $img && $img->exists() ) {
546 # Now try to find a matching old version of a file...
547 if ( $time !== false && $this->oldFileFactoryKey
) { // find-by-sha1 supported?
548 $img = call_user_func( $this->oldFileFactoryKey
, $sha1, $this, $time );
549 if ( $img && $img->exists() ) {
550 if ( !$img->isDeleted( File
::DELETED_FILE
) ) {
551 return $img; // always OK
552 } elseif ( !empty( $options['private'] ) &&
553 $img->userCan( File
::DELETED_FILE
,
554 $options['private'] instanceof User ?
$options['private'] : null
566 * Get an array or iterator of file objects for files that have a given
567 * SHA-1 content hash.
570 * @param string $hash SHA-1 hash
573 public function findBySha1( $hash ) {
578 * Get an array of arrays or iterators of file objects for files that
579 * have the given SHA-1 content hashes.
581 * @param string[] $hashes An array of hashes
582 * @return array[] An Array of arrays or iterators of file objects and the hash as key
584 public function findBySha1s( array $hashes ) {
586 foreach ( $hashes as $hash ) {
587 $files = $this->findBySha1( $hash );
588 if ( count( $files ) ) {
589 $result[$hash] = $files;
597 * Return an array of files where the name starts with $prefix.
600 * @param string $prefix The prefix to search for
601 * @param int $limit The maximum amount of files to return
602 * @return LocalFile[]
604 public function findFilesByPrefix( $prefix, $limit ) {
609 * Get the URL of thumb.php
613 public function getThumbScriptUrl() {
614 return $this->thumbScriptUrl
;
618 * Get the URL thumb.php requests are being proxied to
622 public function getThumbProxyUrl() {
623 return $this->thumbProxyUrl
;
627 * Get the secret key for the proxied thumb service
631 public function getThumbProxySecret() {
632 return $this->thumbProxySecret
;
636 * Returns true if the repository can transform files via a 404 handler
640 public function canTransformVia404() {
641 return $this->transformVia404
;
645 * Get the name of a file from its title object
647 * @param Title $title
650 public function getNameFromTitle( Title
$title ) {
652 if ( $this->initialCapital
!= MWNamespace
::isCapitalized( NS_FILE
) ) {
653 $name = $title->getUserCaseDBKey();
654 if ( $this->initialCapital
) {
655 $name = $wgContLang->ucfirst( $name );
658 $name = $title->getDBkey();
665 * Get the public zone root storage directory of the repository
669 public function getRootDirectory() {
670 return $this->getZonePath( 'public' );
674 * Get a relative path including trailing slash, e.g. f/fa/
675 * If the repo is not hashed, returns an empty string
677 * @param string $name Name of file
680 public function getHashPath( $name ) {
681 return self
::getHashPathForLevel( $name, $this->hashLevels
);
685 * Get a relative path including trailing slash, e.g. f/fa/
686 * If the repo is not hashed, returns an empty string
688 * @param string $suffix Basename of file from FileRepo::storeTemp()
691 public function getTempHashPath( $suffix ) {
692 $parts = explode( '!', $suffix, 2 ); // format is <timestamp>!<name> or just <name>
693 $name = isset( $parts[1] ) ?
$parts[1] : $suffix; // hash path is not based on timestamp
694 return self
::getHashPathForLevel( $name, $this->hashLevels
);
698 * @param string $name
702 protected static function getHashPathForLevel( $name, $levels ) {
703 if ( $levels == 0 ) {
706 $hash = md5( $name );
708 for ( $i = 1; $i <= $levels; $i++
) {
709 $path .= substr( $hash, 0, $i ) . '/';
717 * Get the number of hash directory levels
721 public function getHashLevels() {
722 return $this->hashLevels
;
726 * Get the name of this repository, as specified by $info['name]' to the constructor
730 public function getName() {
735 * Make an url to this repo
737 * @param string $query Query string to append
738 * @param string $entry Entry point; defaults to index
739 * @return string|bool False on failure
741 public function makeUrl( $query = '', $entry = 'index' ) {
742 if ( isset( $this->scriptDirUrl
) ) {
743 return wfAppendQuery( "{$this->scriptDirUrl}/{$entry}.php", $query );
750 * Get the URL of an image description page. May return false if it is
751 * unknown or not applicable. In general this should only be called by the
752 * File class, since it may return invalid results for certain kinds of
753 * repositories. Use File::getDescriptionUrl() in user code.
755 * In particular, it uses the article paths as specified to the repository
756 * constructor, whereas local repositories use the local Title functions.
758 * @param string $name
759 * @return string|false
761 public function getDescriptionUrl( $name ) {
762 $encName = wfUrlencode( $name );
763 if ( !is_null( $this->descBaseUrl
) ) {
764 # "http://example.com/wiki/File:"
765 return $this->descBaseUrl
. $encName;
767 if ( !is_null( $this->articleUrl
) ) {
768 # "http://example.com/wiki/$1"
769 # We use "Image:" as the canonical namespace for
770 # compatibility across all MediaWiki versions.
771 return str_replace( '$1',
772 "Image:$encName", $this->articleUrl
);
774 if ( !is_null( $this->scriptDirUrl
) ) {
775 # "http://example.com/w"
776 # We use "Image:" as the canonical namespace for
777 # compatibility across all MediaWiki versions,
778 # and just sort of hope index.php is right. ;)
779 return $this->makeUrl( "title=Image:$encName" );
786 * Get the URL of the content-only fragment of the description page. For
787 * MediaWiki this means action=render. This should only be called by the
788 * repository's file class, since it may return invalid results. User code
789 * should use File::getDescriptionText().
791 * @param string $name Name of image to fetch
792 * @param string|null $lang Language to fetch it in, if any.
793 * @return string|false
795 public function getDescriptionRenderUrl( $name, $lang = null ) {
796 $query = 'action=render';
797 if ( !is_null( $lang ) ) {
798 $query .= '&uselang=' . urlencode( $lang );
800 if ( isset( $this->scriptDirUrl
) ) {
801 return $this->makeUrl(
803 wfUrlencode( 'Image:' . $name ) .
806 $descUrl = $this->getDescriptionUrl( $name );
808 return wfAppendQuery( $descUrl, $query );
816 * Get the URL of the stylesheet to apply to description pages
818 * @return string|bool False on failure
820 public function getDescriptionStylesheetUrl() {
821 if ( isset( $this->scriptDirUrl
) ) {
822 return $this->makeUrl( 'title=MediaWiki:Filepage.css&' .
823 wfArrayToCgi( Skin
::getDynamicStylesheetQuery() ) );
830 * Store a file to a given destination.
832 * @param string $srcPath Source file system path, storage path, or virtual URL
833 * @param string $dstZone Destination zone
834 * @param string $dstRel Destination relative path
835 * @param int $flags Bitwise combination of the following flags:
836 * self::OVERWRITE Overwrite an existing destination file instead of failing
837 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
838 * same contents as the source
839 * self::SKIP_LOCKING Skip any file locking when doing the store
842 public function store( $srcPath, $dstZone, $dstRel, $flags = 0 ) {
843 $this->assertWritableRepo(); // fail out if read-only
845 $status = $this->storeBatch( [ [ $srcPath, $dstZone, $dstRel ] ], $flags );
846 if ( $status->successCount
== 0 ) {
847 $status->setOK( false );
854 * Store a batch of files
856 * @param array $triplets (src, dest zone, dest rel) triplets as per store()
857 * @param int $flags Bitwise combination of the following flags:
858 * self::OVERWRITE Overwrite an existing destination file instead of failing
859 * self::OVERWRITE_SAME Overwrite the file if the destination exists and has the
860 * same contents as the source
861 * self::SKIP_LOCKING Skip any file locking when doing the store
862 * @throws MWException
865 public function storeBatch( array $triplets, $flags = 0 ) {
866 $this->assertWritableRepo(); // fail out if read-only
868 if ( $flags & self
::DELETE_SOURCE
) {
869 throw new InvalidArgumentException( "DELETE_SOURCE not supported in " . __METHOD__
);
872 $status = $this->newGood();
873 $backend = $this->backend
; // convenience
876 // Validate each triplet and get the store operation...
877 foreach ( $triplets as $triplet ) {
878 list( $srcPath, $dstZone, $dstRel ) = $triplet;
880 . "( \$src='$srcPath', \$dstZone='$dstZone', \$dstRel='$dstRel' )\n"
883 // Resolve destination path
884 $root = $this->getZonePath( $dstZone );
886 throw new MWException( "Invalid zone: $dstZone" );
888 if ( !$this->validateFilename( $dstRel ) ) {
889 throw new MWException( 'Validation error in $dstRel' );
891 $dstPath = "$root/$dstRel";
892 $dstDir = dirname( $dstPath );
893 // Create destination directories for this triplet
894 if ( !$this->initDirectory( $dstDir )->isOK() ) {
895 return $this->newFatal( 'directorycreateerror', $dstDir );
898 // Resolve source to a storage path if virtual
899 $srcPath = $this->resolveToStoragePath( $srcPath );
901 // Get the appropriate file operation
902 if ( FileBackend
::isStoragePath( $srcPath ) ) {
911 'overwrite' => $flags & self
::OVERWRITE
,
912 'overwriteSame' => $flags & self
::OVERWRITE_SAME
,
916 // Execute the store operation for each triplet
917 $opts = [ 'force' => true ];
918 if ( $flags & self
::SKIP_LOCKING
) {
919 $opts['nonLocking'] = true;
921 $status->merge( $backend->doOperations( $operations, $opts ) );
927 * Deletes a batch of files.
928 * Each file can be a (zone, rel) pair, virtual url, storage path.
929 * It will try to delete each file, but ignores any errors that may occur.
931 * @param string[] $files List of files to delete
932 * @param int $flags Bitwise combination of the following flags:
933 * self::SKIP_LOCKING Skip any file locking when doing the deletions
936 public function cleanupBatch( array $files, $flags = 0 ) {
937 $this->assertWritableRepo(); // fail out if read-only
939 $status = $this->newGood();
942 foreach ( $files as $path ) {
943 if ( is_array( $path ) ) {
944 // This is a pair, extract it
945 list( $zone, $rel ) = $path;
946 $path = $this->getZonePath( $zone ) . "/$rel";
948 // Resolve source to a storage path if virtual
949 $path = $this->resolveToStoragePath( $path );
951 $operations[] = [ 'op' => 'delete', 'src' => $path ];
953 // Actually delete files from storage...
954 $opts = [ 'force' => true ];
955 if ( $flags & self
::SKIP_LOCKING
) {
956 $opts['nonLocking'] = true;
958 $status->merge( $this->backend
->doOperations( $operations, $opts ) );
964 * Import a file from the local file system into the repo.
965 * This does no locking nor journaling and overrides existing files.
966 * This function can be used to write to otherwise read-only foreign repos.
967 * This is intended for copying generated thumbnails into the repo.
969 * @param string|FSFile $src Source file system path, storage path, or virtual URL
970 * @param string $dst Virtual URL or storage path
971 * @param array|string|null $options An array consisting of a key named headers
972 * listing extra headers. If a string, taken as content-disposition header.
973 * (Support for array of options new in 1.23)
976 final public function quickImport( $src, $dst, $options = null ) {
977 return $this->quickImportBatch( [ [ $src, $dst, $options ] ] );
981 * Purge a file from the repo. This does no locking nor journaling.
982 * This function can be used to write to otherwise read-only foreign repos.
983 * This is intended for purging thumbnails.
985 * @param string $path Virtual URL or storage path
988 final public function quickPurge( $path ) {
989 return $this->quickPurgeBatch( [ $path ] );
993 * Deletes a directory if empty.
994 * This function can be used to write to otherwise read-only foreign repos.
996 * @param string $dir Virtual URL (or storage path) of directory to clean
999 public function quickCleanDir( $dir ) {
1000 $status = $this->newGood();
1001 $status->merge( $this->backend
->clean(
1002 [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1008 * Import a batch of files from the local file system into the repo.
1009 * This does no locking nor journaling and overrides existing files.
1010 * This function can be used to write to otherwise read-only foreign repos.
1011 * This is intended for copying generated thumbnails into the repo.
1013 * All path parameters may be a file system path, storage path, or virtual URL.
1014 * When "headers" are given they are used as HTTP headers if supported.
1016 * @param array $triples List of (source path or FSFile, destination path, disposition)
1019 public function quickImportBatch( array $triples ) {
1020 $status = $this->newGood();
1022 foreach ( $triples as $triple ) {
1023 list( $src, $dst ) = $triple;
1024 if ( $src instanceof FSFile
) {
1027 $src = $this->resolveToStoragePath( $src );
1028 $op = FileBackend
::isStoragePath( $src ) ?
'copy' : 'store';
1030 $dst = $this->resolveToStoragePath( $dst );
1032 if ( !isset( $triple[2] ) ) {
1034 } elseif ( is_string( $triple[2] ) ) {
1036 $headers = [ 'Content-Disposition' => $triple[2] ];
1037 } elseif ( is_array( $triple[2] ) && isset( $triple[2]['headers'] ) ) {
1038 $headers = $triple[2]['headers'];
1047 'headers' => $headers
1049 $status->merge( $this->initDirectory( dirname( $dst ) ) );
1051 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1057 * Purge a batch of files from the repo.
1058 * This function can be used to write to otherwise read-only foreign repos.
1059 * This does no locking nor journaling and is intended for purging thumbnails.
1061 * @param array $paths List of virtual URLs or storage paths
1064 public function quickPurgeBatch( array $paths ) {
1065 $status = $this->newGood();
1067 foreach ( $paths as $path ) {
1070 'src' => $this->resolveToStoragePath( $path ),
1071 'ignoreMissingSource' => true
1074 $status->merge( $this->backend
->doQuickOperations( $operations ) );
1080 * Pick a random name in the temp zone and store a file to it.
1081 * Returns a Status object with the file Virtual URL in the value,
1082 * file can later be disposed using FileRepo::freeTemp().
1084 * @param string $originalName The base name of the file as specified
1085 * by the user. The file extension will be maintained.
1086 * @param string $srcPath The current location of the file.
1087 * @return Status Object with the URL in the value.
1089 public function storeTemp( $originalName, $srcPath ) {
1090 $this->assertWritableRepo(); // fail out if read-only
1092 $date = MWTimestamp
::getInstance()->format( 'YmdHis' );
1093 $hashPath = $this->getHashPath( $originalName );
1094 $dstUrlRel = $hashPath . $date . '!' . rawurlencode( $originalName );
1095 $virtualUrl = $this->getVirtualUrl( 'temp' ) . '/' . $dstUrlRel;
1097 $result = $this->quickImport( $srcPath, $virtualUrl );
1098 $result->value
= $virtualUrl;
1104 * Remove a temporary file or mark it for garbage collection
1106 * @param string $virtualUrl The virtual URL returned by FileRepo::storeTemp()
1107 * @return bool True on success, false on failure
1109 public function freeTemp( $virtualUrl ) {
1110 $this->assertWritableRepo(); // fail out if read-only
1112 $temp = $this->getVirtualUrl( 'temp' );
1113 if ( substr( $virtualUrl, 0, strlen( $temp ) ) != $temp ) {
1114 wfDebug( __METHOD__
. ": Invalid temp virtual URL\n" );
1119 return $this->quickPurge( $virtualUrl )->isOK();
1123 * Concatenate a list of temporary files into a target file location.
1125 * @param array $srcPaths Ordered list of source virtual URLs/storage paths
1126 * @param string $dstPath Target file system path
1127 * @param int $flags Bitwise combination of the following flags:
1128 * self::DELETE_SOURCE Delete the source files on success
1131 public function concatenate( array $srcPaths, $dstPath, $flags = 0 ) {
1132 $this->assertWritableRepo(); // fail out if read-only
1134 $status = $this->newGood();
1137 foreach ( $srcPaths as $srcPath ) {
1138 // Resolve source to a storage path if virtual
1139 $source = $this->resolveToStoragePath( $srcPath );
1140 $sources[] = $source; // chunk to merge
1143 // Concatenate the chunks into one FS file
1144 $params = [ 'srcs' => $sources, 'dst' => $dstPath ];
1145 $status->merge( $this->backend
->concatenate( $params ) );
1146 if ( !$status->isOK() ) {
1150 // Delete the sources if required
1151 if ( $flags & self
::DELETE_SOURCE
) {
1152 $status->merge( $this->quickPurgeBatch( $srcPaths ) );
1155 // Make sure status is OK, despite any quickPurgeBatch() fatals
1156 $status->setResult( true );
1162 * Copy or move a file either from a storage path, virtual URL,
1163 * or file system path, into this repository at the specified destination location.
1165 * Returns a Status object. On success, the value contains "new" or
1166 * "archived", to indicate whether the file was new with that name.
1168 * Options to $options include:
1169 * - headers : name/value map of HTTP headers to use in response to GET/HEAD requests
1171 * @param string|FSFile $src The source file system path, storage path, or URL
1172 * @param string $dstRel The destination relative path
1173 * @param string $archiveRel The relative path where the existing file is to
1174 * be archived, if there is one. Relative to the public zone root.
1175 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1176 * that the source file should be deleted if possible
1177 * @param array $options Optional additional parameters
1180 public function publish(
1181 $src, $dstRel, $archiveRel, $flags = 0, array $options = []
1183 $this->assertWritableRepo(); // fail out if read-only
1185 $status = $this->publishBatch(
1186 [ [ $src, $dstRel, $archiveRel, $options ] ], $flags );
1187 if ( $status->successCount
== 0 ) {
1188 $status->setOK( false );
1190 if ( isset( $status->value
[0] ) ) {
1191 $status->value
= $status->value
[0];
1193 $status->value
= false;
1200 * Publish a batch of files
1202 * @param array $ntuples (source, dest, archive) triplets or
1203 * (source, dest, archive, options) 4-tuples as per publish().
1204 * @param int $flags Bitfield, may be FileRepo::DELETE_SOURCE to indicate
1205 * that the source files should be deleted if possible
1206 * @throws MWException
1209 public function publishBatch( array $ntuples, $flags = 0 ) {
1210 $this->assertWritableRepo(); // fail out if read-only
1212 $backend = $this->backend
; // convenience
1213 // Try creating directories
1214 $status = $this->initZones( 'public' );
1215 if ( !$status->isOK() ) {
1219 $status = $this->newGood( [] );
1222 $sourceFSFilesToDelete = []; // cleanup for disk source files
1223 // Validate each triplet and get the store operation...
1224 foreach ( $ntuples as $ntuple ) {
1225 list( $src, $dstRel, $archiveRel ) = $ntuple;
1226 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1228 $options = isset( $ntuple[3] ) ?
$ntuple[3] : [];
1229 // Resolve source to a storage path if virtual
1230 $srcPath = $this->resolveToStoragePath( $srcPath );
1231 if ( !$this->validateFilename( $dstRel ) ) {
1232 throw new MWException( 'Validation error in $dstRel' );
1234 if ( !$this->validateFilename( $archiveRel ) ) {
1235 throw new MWException( 'Validation error in $archiveRel' );
1238 $publicRoot = $this->getZonePath( 'public' );
1239 $dstPath = "$publicRoot/$dstRel";
1240 $archivePath = "$publicRoot/$archiveRel";
1242 $dstDir = dirname( $dstPath );
1243 $archiveDir = dirname( $archivePath );
1244 // Abort immediately on directory creation errors since they're likely to be repetitive
1245 if ( !$this->initDirectory( $dstDir )->isOK() ) {
1246 return $this->newFatal( 'directorycreateerror', $dstDir );
1248 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1249 return $this->newFatal( 'directorycreateerror', $archiveDir );
1252 // Set any desired headers to be use in GET/HEAD responses
1253 $headers = isset( $options['headers'] ) ?
$options['headers'] : [];
1255 // Archive destination file if it exists.
1256 // This will check if the archive file also exists and fail if does.
1257 // This is a sanity check to avoid data loss. On Windows and Linux,
1258 // copy() will overwrite, so the existence check is vulnerable to
1259 // race conditions unless a functioning LockManager is used.
1260 // LocalFile also uses SELECT FOR UPDATE for synchronization.
1264 'dst' => $archivePath,
1265 'ignoreMissingSource' => true
1268 // Copy (or move) the source file to the destination
1269 if ( FileBackend
::isStoragePath( $srcPath ) ) {
1270 if ( $flags & self
::DELETE_SOURCE
) {
1275 'overwrite' => true, // replace current
1276 'headers' => $headers
1283 'overwrite' => true, // replace current
1284 'headers' => $headers
1287 } else { // FS source path
1290 'src' => $src, // prefer FSFile objects
1292 'overwrite' => true, // replace current
1293 'headers' => $headers
1295 if ( $flags & self
::DELETE_SOURCE
) {
1296 $sourceFSFilesToDelete[] = $srcPath;
1301 // Execute the operations for each triplet
1302 $status->merge( $backend->doOperations( $operations ) );
1303 // Find out which files were archived...
1304 foreach ( $ntuples as $i => $ntuple ) {
1305 list( , , $archiveRel ) = $ntuple;
1306 $archivePath = $this->getZonePath( 'public' ) . "/$archiveRel";
1307 if ( $this->fileExists( $archivePath ) ) {
1308 $status->value
[$i] = 'archived';
1310 $status->value
[$i] = 'new';
1313 // Cleanup for disk source files...
1314 foreach ( $sourceFSFilesToDelete as $file ) {
1315 Wikimedia\
suppressWarnings();
1316 unlink( $file ); // FS cleanup
1317 Wikimedia\restoreWarnings
();
1324 * Creates a directory with the appropriate zone permissions.
1325 * Callers are responsible for doing read-only and "writable repo" checks.
1327 * @param string $dir Virtual URL (or storage path) of directory to clean
1330 protected function initDirectory( $dir ) {
1331 $path = $this->resolveToStoragePath( $dir );
1332 list( , $container, ) = FileBackend
::splitStoragePath( $path );
1334 $params = [ 'dir' => $path ];
1335 if ( $this->isPrivate
1336 ||
$container === $this->zones
['deleted']['container']
1337 ||
$container === $this->zones
['temp']['container']
1339 # Take all available measures to prevent web accessibility of new deleted
1340 # directories, in case the user has not configured offline storage
1341 $params = [ 'noAccess' => true, 'noListing' => true ] +
$params;
1344 $status = $this->newGood();
1345 $status->merge( $this->backend
->prepare( $params ) );
1351 * Deletes a directory if empty.
1353 * @param string $dir Virtual URL (or storage path) of directory to clean
1356 public function cleanDir( $dir ) {
1357 $this->assertWritableRepo(); // fail out if read-only
1359 $status = $this->newGood();
1360 $status->merge( $this->backend
->clean(
1361 [ 'dir' => $this->resolveToStoragePath( $dir ) ] ) );
1367 * Checks existence of a a file
1369 * @param string $file Virtual URL (or storage path) of file to check
1372 public function fileExists( $file ) {
1373 $result = $this->fileExistsBatch( [ $file ] );
1379 * Checks existence of an array of files.
1381 * @param string[] $files Virtual URLs (or storage paths) of files to check
1382 * @return array Map of files and existence flags, or false
1384 public function fileExistsBatch( array $files ) {
1385 $paths = array_map( [ $this, 'resolveToStoragePath' ], $files );
1386 $this->backend
->preloadFileStat( [ 'srcs' => $paths ] );
1389 foreach ( $files as $key => $file ) {
1390 $path = $this->resolveToStoragePath( $file );
1391 $result[$key] = $this->backend
->fileExists( [ 'src' => $path ] );
1398 * Move a file to the deletion archive.
1399 * If no valid deletion archive exists, this may either delete the file
1400 * or throw an exception, depending on the preference of the repository
1402 * @param mixed $srcRel Relative path for the file to be deleted
1403 * @param mixed $archiveRel Relative path for the archive location.
1404 * Relative to a private archive directory.
1407 public function delete( $srcRel, $archiveRel ) {
1408 $this->assertWritableRepo(); // fail out if read-only
1410 return $this->deleteBatch( [ [ $srcRel, $archiveRel ] ] );
1414 * Move a group of files to the deletion archive.
1416 * If no valid deletion archive is configured, this may either delete the
1417 * file or throw an exception, depending on the preference of the repository.
1419 * The overwrite policy is determined by the repository -- currently LocalRepo
1420 * assumes a naming scheme in the deleted zone based on content hash, as
1421 * opposed to the public zone which is assumed to be unique.
1423 * @param array $sourceDestPairs Array of source/destination pairs. Each element
1424 * is a two-element array containing the source file path relative to the
1425 * public root in the first element, and the archive file path relative
1426 * to the deleted zone root in the second element.
1427 * @throws MWException
1430 public function deleteBatch( array $sourceDestPairs ) {
1431 $this->assertWritableRepo(); // fail out if read-only
1433 // Try creating directories
1434 $status = $this->initZones( [ 'public', 'deleted' ] );
1435 if ( !$status->isOK() ) {
1439 $status = $this->newGood();
1441 $backend = $this->backend
; // convenience
1443 // Validate filenames and create archive directories
1444 foreach ( $sourceDestPairs as $pair ) {
1445 list( $srcRel, $archiveRel ) = $pair;
1446 if ( !$this->validateFilename( $srcRel ) ) {
1447 throw new MWException( __METHOD__
. ':Validation error in $srcRel' );
1448 } elseif ( !$this->validateFilename( $archiveRel ) ) {
1449 throw new MWException( __METHOD__
. ':Validation error in $archiveRel' );
1452 $publicRoot = $this->getZonePath( 'public' );
1453 $srcPath = "{$publicRoot}/$srcRel";
1455 $deletedRoot = $this->getZonePath( 'deleted' );
1456 $archivePath = "{$deletedRoot}/{$archiveRel}";
1457 $archiveDir = dirname( $archivePath ); // does not touch FS
1459 // Create destination directories
1460 if ( !$this->initDirectory( $archiveDir )->isOK() ) {
1461 return $this->newFatal( 'directorycreateerror', $archiveDir );
1467 'dst' => $archivePath,
1468 // We may have 2+ identical files being deleted,
1469 // all of which will map to the same destination file
1470 'overwriteSame' => true // also see T33792
1474 // Move the files by execute the operations for each pair.
1475 // We're now committed to returning an OK result, which will
1476 // lead to the files being moved in the DB also.
1477 $opts = [ 'force' => true ];
1478 $status->merge( $backend->doOperations( $operations, $opts ) );
1484 * Delete files in the deleted directory if they are not referenced in the filearchive table
1487 * @param string[] $storageKeys
1489 public function cleanupDeletedBatch( array $storageKeys ) {
1490 $this->assertWritableRepo();
1494 * Get a relative path for a deletion archive key,
1495 * e.g. s/z/a/ for sza251lrxrc1jad41h5mgilp8nysje52.jpg
1497 * @param string $key
1498 * @throws MWException
1501 public function getDeletedHashPath( $key ) {
1502 if ( strlen( $key ) < 31 ) {
1503 throw new MWException( "Invalid storage key '$key'." );
1506 for ( $i = 0; $i < $this->deletedHashLevels
; $i++
) {
1507 $path .= $key[$i] . '/';
1514 * If a path is a virtual URL, resolve it to a storage path.
1515 * Otherwise, just return the path as it is.
1517 * @param string $path
1519 * @throws MWException
1521 protected function resolveToStoragePath( $path ) {
1522 if ( $this->isVirtualUrl( $path ) ) {
1523 return $this->resolveVirtualUrl( $path );
1530 * Get a local FS copy of a file with a given virtual URL/storage path.
1531 * Temporary files may be purged when the file object falls out of scope.
1533 * @param string $virtualUrl
1534 * @return TempFSFile|null Returns null on failure
1536 public function getLocalCopy( $virtualUrl ) {
1537 $path = $this->resolveToStoragePath( $virtualUrl );
1539 return $this->backend
->getLocalCopy( [ 'src' => $path ] );
1543 * Get a local FS file with a given virtual URL/storage path.
1544 * The file is either an original or a copy. It should not be changed.
1545 * Temporary files may be purged when the file object falls out of scope.
1547 * @param string $virtualUrl
1548 * @return FSFile|null Returns null on failure.
1550 public function getLocalReference( $virtualUrl ) {
1551 $path = $this->resolveToStoragePath( $virtualUrl );
1553 return $this->backend
->getLocalReference( [ 'src' => $path ] );
1557 * Get properties of a file with a given virtual URL/storage path.
1558 * Properties should ultimately be obtained via FSFile::getProps().
1560 * @param string $virtualUrl
1563 public function getFileProps( $virtualUrl ) {
1564 $fsFile = $this->getLocalReference( $virtualUrl );
1565 $mwProps = new MWFileProps( MediaWiki\MediaWikiServices
::getInstance()->getMimeAnalyzer() );
1567 $props = $mwProps->getPropsFromPath( $fsFile->getPath(), true );
1569 $props = $mwProps->newPlaceholderProps();
1576 * Get the timestamp of a file with a given virtual URL/storage path
1578 * @param string $virtualUrl
1579 * @return string|bool False on failure
1581 public function getFileTimestamp( $virtualUrl ) {
1582 $path = $this->resolveToStoragePath( $virtualUrl );
1584 return $this->backend
->getFileTimestamp( [ 'src' => $path ] );
1588 * Get the size of a file with a given virtual URL/storage path
1590 * @param string $virtualUrl
1591 * @return int|bool False on failure
1593 public function getFileSize( $virtualUrl ) {
1594 $path = $this->resolveToStoragePath( $virtualUrl );
1596 return $this->backend
->getFileSize( [ 'src' => $path ] );
1600 * Get the sha1 (base 36) of a file with a given virtual URL/storage path
1602 * @param string $virtualUrl
1603 * @return string|bool
1605 public function getFileSha1( $virtualUrl ) {
1606 $path = $this->resolveToStoragePath( $virtualUrl );
1608 return $this->backend
->getFileSha1Base36( [ 'src' => $path ] );
1612 * Attempt to stream a file with the given virtual URL/storage path
1614 * @param string $virtualUrl
1615 * @param array $headers Additional HTTP headers to send on success
1616 * @param array $optHeaders HTTP request headers (if-modified-since, range, ...)
1620 public function streamFileWithStatus( $virtualUrl, $headers = [], $optHeaders = [] ) {
1621 $path = $this->resolveToStoragePath( $virtualUrl );
1622 $params = [ 'src' => $path, 'headers' => $headers, 'options' => $optHeaders ];
1624 // T172851: HHVM does not flush the output properly, causing OOM
1625 ob_start( null, 1048576 );
1626 ob_implicit_flush( true );
1628 $status = $this->newGood();
1629 $status->merge( $this->backend
->streamFile( $params ) );
1637 * Attempt to stream a file with the given virtual URL/storage path
1639 * @deprecated since 1.26, use streamFileWithStatus
1640 * @param string $virtualUrl
1641 * @param array $headers Additional HTTP headers to send on success
1642 * @return bool Success
1644 public function streamFile( $virtualUrl, $headers = [] ) {
1645 return $this->streamFileWithStatus( $virtualUrl, $headers )->isOK();
1649 * Call a callback function for every public regular file in the repository.
1650 * This only acts on the current version of files, not any old versions.
1651 * May use either the database or the filesystem.
1653 * @param callable $callback
1656 public function enumFiles( $callback ) {
1657 $this->enumFilesInStorage( $callback );
1661 * Call a callback function for every public file in the repository.
1662 * May use either the database or the filesystem.
1664 * @param callable $callback
1667 protected function enumFilesInStorage( $callback ) {
1668 $publicRoot = $this->getZonePath( 'public' );
1669 $numDirs = 1 << ( $this->hashLevels
* 4 );
1670 // Use a priori assumptions about directory structure
1671 // to reduce the tree height of the scanning process.
1672 for ( $flatIndex = 0; $flatIndex < $numDirs; $flatIndex++
) {
1673 $hexString = sprintf( "%0{$this->hashLevels}x", $flatIndex );
1674 $path = $publicRoot;
1675 for ( $hexPos = 0; $hexPos < $this->hashLevels
; $hexPos++
) {
1676 $path .= '/' . substr( $hexString, 0, $hexPos +
1 );
1678 $iterator = $this->backend
->getFileList( [ 'dir' => $path ] );
1679 foreach ( $iterator as $name ) {
1680 // Each item returned is a public file
1681 call_user_func( $callback, "{$path}/{$name}" );
1687 * Determine if a relative path is valid, i.e. not blank or involving directory traveral
1689 * @param string $filename
1692 public function validateFilename( $filename ) {
1693 if ( strval( $filename ) == '' ) {
1697 return FileBackend
::isPathTraversalFree( $filename );
1701 * Get a callback function to use for cleaning error message parameters
1705 function getErrorCleanupFunction() {
1706 switch ( $this->pathDisclosureProtection
) {
1708 case 'simple': // b/c
1709 $callback = [ $this, 'passThrough' ];
1711 default: // 'paranoid'
1712 $callback = [ $this, 'paranoidClean' ];
1718 * Path disclosure protection function
1720 * @param string $param
1723 function paranoidClean( $param ) {
1728 * Path disclosure protection function
1730 * @param string $param
1733 function passThrough( $param ) {
1738 * Create a new fatal error
1740 * @param string $message
1743 public function newFatal( $message /*, parameters...*/ ) {
1744 $status = call_user_func_array( [ Status
::class, 'newFatal' ], func_get_args() );
1745 $status->cleanCallback
= $this->getErrorCleanupFunction();
1751 * Create a new good result
1753 * @param null|string $value
1756 public function newGood( $value = null ) {
1757 $status = Status
::newGood( $value );
1758 $status->cleanCallback
= $this->getErrorCleanupFunction();
1764 * Checks if there is a redirect named as $title. If there is, return the
1765 * title object. If not, return false.
1768 * @param Title $title Title of image
1771 public function checkRedirect( Title
$title ) {
1776 * Invalidates image redirect cache related to that image
1777 * Doesn't do anything for repositories that don't support image redirects.
1780 * @param Title $title Title of image
1782 public function invalidateImageRedirect( Title
$title ) {
1786 * Get the human-readable name of the repo
1790 public function getDisplayName() {
1793 if ( $this->isLocal() ) {
1797 // 'shared-repo-name-wikimediacommons' is used when $wgUseInstantCommons = true
1798 return wfMessageFallback( 'shared-repo-name-' . $this->name
, 'shared-repo' )->text();
1802 * Get the portion of the file that contains the origin file name.
1803 * If that name is too long, then the name "thumbnail.<ext>" will be given.
1805 * @param string $name
1808 public function nameForThumb( $name ) {
1809 if ( strlen( $name ) > $this->abbrvThreshold
) {
1810 $ext = FileBackend
::extensionFromPath( $name );
1811 $name = ( $ext == '' ) ?
'thumbnail' : "thumbnail.$ext";
1818 * Returns true if this the local file repository.
1822 public function isLocal() {
1823 return $this->getName() == 'local';
1827 * Get a key on the primary cache for this repository.
1828 * Returns false if the repository's cache is not accessible at this site.
1829 * The parameters are the parts of the key, as for wfMemcKey().
1834 public function getSharedCacheKey( /*...*/ ) {
1839 * Get a key for this repo in the local cache domain. These cache keys are
1840 * not shared with remote instances of the repo.
1841 * The parameters are the parts of the key, as for wfMemcKey().
1845 public function getLocalCacheKey( /*...*/ ) {
1846 $args = func_get_args();
1847 array_unshift( $args, 'filerepo', $this->getName() );
1849 return call_user_func_array( 'wfMemcKey', $args );
1853 * Get a temporary private FileRepo associated with this repo.
1855 * Files will be created in the temp zone of this repo.
1856 * It will have the same backend as this repo.
1858 * @return TempFileRepo
1860 public function getTempRepo() {
1861 return new TempFileRepo( [
1862 'name' => "{$this->name}-temp",
1863 'backend' => $this->backend
,
1866 // Same place storeTemp() uses in the base repo, though
1867 // the path hashing is mismatched, which is annoying.
1868 'container' => $this->zones
['temp']['container'],
1869 'directory' => $this->zones
['temp']['directory']
1872 'container' => $this->zones
['temp']['container'],
1873 'directory' => $this->zones
['temp']['directory'] == ''
1875 : $this->zones
['temp']['directory'] . '/thumb'
1878 'container' => $this->zones
['temp']['container'],
1879 'directory' => $this->zones
['temp']['directory'] == ''
1881 : $this->zones
['temp']['directory'] . '/transcoded'
1884 'hashLevels' => $this->hashLevels
, // performance
1885 'isPrivate' => true // all in temp zone
1890 * Get an UploadStash associated with this repo.
1892 * @param User|null $user
1893 * @return UploadStash
1895 public function getUploadStash( User
$user = null ) {
1896 return new UploadStash( $this, $user );
1900 * Throw an exception if this repo is read-only by design.
1901 * This does not and should not check getReadOnlyReason().
1904 * @throws MWException
1906 protected function assertWritableRepo() {
1910 * Return information about the repository.
1915 public function getInfo() {
1917 'name' => $this->getName(),
1918 'displayname' => $this->getDisplayName(),
1919 'rootUrl' => $this->getZoneUrl( 'public' ),
1920 'local' => $this->isLocal(),
1923 $optionalSettings = [
1924 'url', 'thumbUrl', 'initialCapital', 'descBaseUrl', 'scriptDirUrl', 'articleUrl',
1925 'fetchDescription', 'descriptionCacheExpiry', 'favicon'
1927 foreach ( $optionalSettings as $k ) {
1928 if ( isset( $this->$k ) ) {
1929 $ret[$k] = $this->$k;
1937 * Returns whether or not storage is SHA-1 based
1940 public function hasSha1Storage() {
1941 return $this->hasSha1Storage
;
1945 * Returns whether or not repo supports having originals SHA-1s in the thumb URLs
1948 public function supportsSha1URLs() {
1949 return $this->supportsSha1URLs
;